home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / lollipop / lists.tex < prev    next >
Text File  |  1993-01-28  |  11KB  |  341 lines
  1. % Lists.tex copyright 1992/3 Victor Eijkhout
  2. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  3. %%%%%%%%%%%%%%% L I S T S 
  4.  
  5.  
  6. \@GenericConstruct{List}
  7.  
  8. \newif\if@initem \@initemyes \newif\if@alitem
  9. \newbox\@labelbox 
  10.  
  11. \def\item{\Emessage{Item command outside list}}
  12.  
  13. % Breakpoints around a list
  14. %
  15. % first redefine generic defaults:
  16. % try not to break before, maybe not after,
  17. %
  18. \add@List@default{\def\@beforepenalty{\penalty1000 }}
  19. \add@List@default{\def\@afterpenalty{\penalty200 }}
  20.  
  21. % between items is okay
  22. % 
  23. \add@List@default{\def\@betweenpenalty{\penalty-50 }}
  24. \@ListOption{breakbetween}{
  25.     \switch {\if\EqualString{#1}}
  26.     {no}  {\def\@betweenpenalty{\penalty\@M}}
  27.     {yes} {\def\@betweenpenalty{\CSname{\h@or@v fil}\penalty-\@M}}
  28.     {0}   {\def\@betweenpenalty{}}
  29.     {default} {\edef\cs@e{\def\nxp\@betweenpenalty{\penalty\@w@w{#1}\relax}}
  30.                \cs@e}
  31.     \endswitch
  32.     }
  33.  
  34. \newtoks\indent@depth
  35. \add@List@default{\indent@depth={}}
  36.  
  37. \noeol
  38. \def\@DefineList{
  39.     \@DefineStopCommand{\nxp\xx@label \the\item@e@coms\@gen@close}
  40.     \csarg\edef{\@name}{\@gen@open
  41.          \ifitem@list \nxp\step@counter{itemlevel}\fi
  42.          \ifenum@list \nxp\step@counter{enumlevel}
  43.             \nxp\represent@counter{item}
  44.                 {\nxp\enum@repr{\counter@@name{enumlevel}}}\fi
  45.          \ifleft@embedded@construct \previousindent\z@
  46.              \else \nxp\PushIndentLevel 
  47.                    \ifauto@indent \else \levelindent\the\indent@depth \fi
  48.                    \parindent\levelindent
  49.              \fi
  50.          \nxp\@alitemno
  51.          \nxp\start@counter{item}%
  52.          \the\item@b@coms
  53.          \def\nxp\item@label{
  54.              \nxp\ifdim\wd\@labelbox>\tempdima
  55.                  \ifitem@tab \advance\tempdima20pt\relax
  56.                              {\nxp\item@label}
  57.                  \else \iflabel@flow@right 
  58.                              \ifleft@embedded@construct
  59.                              \else\hskip-\previousindent\fi
  60.                              \box\@labelbox
  61.                        \else \nxp\llap{\box\@labelbox}\fi\fi
  62.              \nxp\else \llap{\hbox to \tempdima
  63.                 {\ifleft@item\else\hfil\fi
  64.                  \box\@labelbox \ifleft@item\hfil\fi}}
  65.              \nxp\fi}%
  66.          \def\nxp\num@item
  67.             {\setbox\@labelbox=\hbox{\the\item@coms}
  68.              \tempdima\previousindent
  69.              \nxp\item@label %\nxp\Indent:no
  70.              \the\item@a@coms \nxp\xx@label}
  71.          \def\nxp\item
  72.             {\ifleft@embedded@construct
  73.              \else \nxp\if@alitem\@par%\CSname{@itembreek}%
  74.                    \nxp\hold@parskip \nxp\fi \fi
  75.              \nxp\if\nxp\TestCounter:item >0 \@betweenpenalty \nxp\fi
  76.              \CSname{@\h@or@v white}{\white@between}
  77.              \nxp\@initemno \nxp\@alitemyes \nxp\noindent
  78.              \nxp\step@counter{item}\relax 
  79.              \iflabel@defined\else\nxp\define@reference{item}\fi
  80.              \CSname{\@name @item}}
  81.          }
  82.     \csarg\edef{\@name @item}{
  83.          \iflist@has@description \nxp\desc@item
  84.          \else \nxp\num@item\fi}
  85.     \@Labelize{\@name @item}
  86.     }
  87. \normaleol
  88.  
  89. % Inside a list Foo \item is defined as
  90. %
  91. % \item = all sorts of skips and switches
  92. %         step item counter, define reference
  93. %         \Foo@item
  94. %
  95. % \Foo@item[opt.lab.] = \desc@item or \num@item
  96. %
  97. % \desc@item =
  98. % { \aftergroup\num@item \@description}
  99. %
  100. % \num@item = \item@label \item@a@coms \xx@label
  101. %
  102.  
  103. % Item
  104. % start with start/left/right
  105. % indicating alignment, start = left
  106. %
  107. \newif\ifleft@item \newif\ifitem@tab
  108. \add@List@default{\left@itemyes \item@tabno}
  109. \newtoks\item@coms % content of the item label
  110. \newtoks\item@b@coms % start of the list?
  111. \newtoks\item@a@coms % immediately after the item
  112. \newtoks\item@e@coms % after the whole list
  113. \add@List@default{\item@coms{}\item@b@coms{}\item@a@coms{}
  114.     \item@e@coms{}\def\@current@options@list{item@b@coms}}
  115. \@ListOption{item}{
  116.     \switch {\if\EqualString{#1}}
  117.     {stop} {\@add@toks{\egroup}\e@group
  118.          \def\@current@options@list{item@a@coms}}
  119.     {tabstop} {\item@tabyes
  120.              \@add@toks{\egroup}\e@group
  121.              \def\@current@options@list{item@a@coms}}
  122.     {left} {\global\left@itemyes
  123.              \b@group\def\@current@options@list{item@coms}%
  124.              \@add@toks{\bgroup}}
  125.     {start}{\global\left@itemyes
  126.              \b@group\def\@current@options@list{item@coms}%
  127.              \@add@toks{\bgroup}}
  128.     {right}{\global\left@itemno
  129.              \b@group\def\@current@options@list{item@coms}%
  130.              \@add@toks{\bgroup}}
  131.     {default} {\Emessage{Unknown option #1 for List, item}}
  132.     \endswitch}
  133.  
  134. % Label overflow
  135. %
  136. \newif\iflabel@flow@right
  137. \add@List@default{\label@flow@rightyes}
  138. \@ListOption{labeloverflow}{
  139.     \if\EqualString{#1}{left}\label@flow@rightno
  140.     \else\label@flow@rightyes\fi}
  141.  
  142. % Description
  143. % the line after \item gets picked up,
  144. % and becomes available as `description'
  145. %
  146. \newif\iflist@has@description
  147. \add@List@default{\list@has@descriptionno}
  148. \@ListOption{description}{
  149.     \global\list@has@descriptionyes \@add@toks{\description@text}}
  150. {\noeol
  151.  \othercr
  152. \gdef\@description{\bgroup\othercr \@@description}
  153. \gdef\@@description#1^^M
  154.     {\gdef\description@text{#1}%
  155.     \egroup % balance the \bgroup in \@description
  156.             % which kept the \othercr local
  157.     \egroup % balance the \bgroup in \desc@item
  158.             % which enabled the \aftergroup\num@item
  159.     }
  160. }
  161. \def\desc@item{\bgroup    
  162.     \aftergroup\num@item
  163.     \@description}
  164.  
  165. % White between items
  166. %
  167. \add@List@default{\def\white@between{0pt}}
  168. \@ListOption{whitebetween}{\def\white@between{#1}}
  169. %    \edef\white@between{\@w@w{#1}}}
  170.  
  171. % Indentation
  172. % is automatic (default) and level dependent
  173. % or explicit
  174. %
  175. \newif\ifauto@indent
  176. \add@List@default{\auto@indentyes}
  177. \@ListOption{indentation}{
  178.     \if\EqualString{#1}{automatic}\auto@indentyes
  179.     \else\auto@indentno
  180.          \edef\cs@e{\nxp\indent@depth={\@w@w{#1}}}\cs@e
  181.     \fi}
  182.  
  183. % Tail of the list:
  184. % everything after the keyword 'text' is tail
  185. %
  186. \@ListOption{text}{\at@breakpointyes
  187.     \def\@current@options@list{item@e@coms}}
  188.  
  189. %%%%%%%%%%%%%%%% List Nesting Counters
  190. %
  191.  
  192. % Item sign
  193. % gives the default, level dependent marker
  194. %
  195. \new@@counter{itemlevel} \set@counter{itemlevel}0
  196. \newif\ifitem@list
  197. \add@List@default{\item@listno}
  198. \@ListOption{itemsign}{
  199.     \global\item@listyes
  200.     \edef\cs@e{\nxp\@add@toks
  201.                 {\nxp\ifcustom@label\nxp\the\current@label
  202.                  \nxp\else\nxp\item@sign\counter@@name{itemlevel}%
  203.                  \nxp\fi}}
  204.     \cs@e}
  205. \def\@item@sign#1{itemsign\romannumeral#1}
  206. \def\item@sign#1{\ifnotdefined{\@item@sign{#1}}\@@item@sign{#1}%
  207.     \else \csname \@item@sign{#1}\endcsname \fi}
  208. \def\@@item@sign#1{\ifcase#1\relax\or
  209.     $\bullet$\or $\circ$ \or --\else $\cdot$\fi}
  210. \def\SetItemSign:#1=#2{\csarg\edef{\@item@sign{#1}}%
  211.    {\cswitch \ifx#2 in:
  212.     b $\bullet$;
  213.     c $\circ$;
  214.     d $\diamond$;
  215.     m ---;
  216.     n --;
  217.     . $\cdot$;
  218.     default $\cdot$;
  219.     \endswitch}}
  220.  
  221. % Item Counter 
  222. % 
  223. % Allocate a bare bones counter
  224. \new@@counter{item}\represent@counter{item}1
  225. \newtoks\item@RL \item@RL{}
  226.  
  227. % Keep track of enumerate list level
  228. %
  229. \new@@counter{enumlevel} \set@counter{enumlevel}0
  230. \newif\ifenum@list
  231. \add@List@default{\enum@listno}
  232. \@ListOption{itemCounter}{
  233.     \global\enum@listyes
  234.     \@add@toks{\pad@clear\ifcustom@label\the\current@label
  235.                \else\itemCounter\fi}
  236.     }
  237. \def\@enum@repr#1{enumrepr\romannumeral#1}
  238. \def\enum@repr#1{\ifnotdefined{\@enum@repr{#1}}\@@enum@repr{#1}%
  239.     \else \csname \@enum@repr{#1}\endcsname \fi}
  240. \def\@@enum@repr#1{\ifcase#1\relax\or
  241.     1\or A\or I\or a\or i\else 1\fi}
  242. \def\SetItemCounterRepresentation:#1=#2{\csarg\edef{\@enum@repr{#1}}{#2}}
  243.  
  244. %
  245. \def\@itembreek{\if@initem\par\fi}
  246.  
  247. % Clear items for Widest.
  248. % this is rather susceptible for improvement.
  249. %
  250. \def\ClearFor:#1 
  251.    {\def\widest@pad{#1}}
  252. \def\widest@pad{\m@ne}
  253. \def\pad@clear{\ifnum\widest@pad=\m@ne\else
  254.     \tempcounta\widest@pad
  255.     \advance\tempcounta-\LogTen{\cs@counter@name{item}}\relax
  256.     \hphantom{\ifcase\tempcounta \or 9\or 99 \or 999 \or 9999 \else 99999\fi
  257.               }%
  258.     \fi}
  259.  
  260. %%%%%%%%%%%%%%%% Stripped Lists
  261. %
  262. % for use in external files
  263. %
  264.  
  265. \@GenericConstruct{ExternalItem}%stripped list
  266.  
  267. \add@ExternalItem@default{\extra@args\tw@}
  268.  
  269. \noeol
  270. \def\@DefineExternalItem{
  271.     \@DefineStopCommand{\@gen@close}
  272.     \ifx\pre@fix\@empty \Wmessage{No file for external item: \@name}\fi
  273.     \edef\cs@e{\nxp\append@to@list
  274.          {\pre@fix @local@defs}
  275.          {\nxp\ifnotdefined{\@command}
  276.                    \nxp\Wmessage{Item `\@name' not defined for `\pre@fix'}
  277.           \nxp\else\let\CSname{\@name}\CSname{\@command}
  278.           \nxp\fi}}
  279.     \cs@e
  280.     \csarg\edef{\@command}##1##2{
  281.          \def\CSname{\@name Label}{##1}
  282.          \@gen@open\def\nxp\Page{##2}
  283.          \nxp\PushIndentLevel \let\nxp\nl\relax
  284.          \the\item@b@coms
  285.          \def\nxp\item{\ifleft@embedded@construct\else\noindent\fi
  286.              \setbox\@labelbox=\hbox{\the\item@coms}
  287.              \nxp\ifdim\wd\@labelbox>\previousindent
  288.                  \iflabel@flow@right \hskip-\previousindent\box\@labelbox
  289.                  \else \nxp\llap{\box\@labelbox}\fi
  290.              \nxp\else \llap{\hbox to \previousindent
  291.                 {\ifleft@item\else\hfil\fi
  292.                  \box\@labelbox \ifleft@item\hfil\fi}}
  293.              \nxp\fi}%
  294.          \ifexternal@item@has@item\nxp\item\the\item@a@coms\fi
  295.          \ifright@embedded@construct\else\@par\fi
  296.          \iflong@external\else\nxp\>\fi
  297.          }
  298.     }
  299. \normaleol
  300.  
  301. \add@ExternalItem@default{\@whitebefore\z@toks}
  302. \add@ExternalItem@default{\@whiteafter\z@toks}
  303. \add@ExternalItem@default{\let\Page\@space 
  304.     \csarg\let{\@name Label}\@space}
  305.  
  306. % Specify for what external file this is meant
  307. %
  308. \@ExternalItemOption{file}{\def\pre@fix{#1}}
  309.  
  310. \newif\iflong@external
  311. \add@ExternalItem@default{\long@externalno}
  312. \@ExternalItemOption{long}{
  313.     \csname long@external#1\endcsname}
  314.  
  315. % Commands before and after
  316. % option 'title' is dummy
  317. %
  318. %\@ExternalItemOption{title}{}
  319. % dangerous: better rely on automatic titelization
  320.  
  321. % Item
  322. % start with start/left/right
  323. % indicating alignment, start = left
  324. %
  325. \add@ExternalItem@default{\left@itemyes}
  326. \add@ExternalItem@default{\item@coms{}\item@b@coms{}\item@e@coms{}
  327.     \item@a@coms{}\def\@current@options@list{item@b@coms}}
  328. \newif\ifexternal@item@has@item
  329. \adds@ExternalItem@default{\external@item@has@itemno}
  330. \def\ExternalItem@item{\external@item@has@itemyes
  331.   \List@item}
  332.  
  333. % Label overflow
  334. %
  335. \add@ExternalItem@default{\label@flow@rightyes}
  336. \let\ExternalItem@labeloverflow\List@labeloverflow
  337.  
  338. \endinput
  339.  
  340. 92/11/26 itemsign / itemCounter changed to handle custom@label
  341. 93/01/03 item call in ExternalItem made conditional